Skip to content

chore: refactor execute query in Appsmith AI Plugin#38013

Merged
nsarupr merged 4 commits intoreleasefrom
chore/appsmith-ai-refactor
Dec 9, 2024
Merged

chore: refactor execute query in Appsmith AI Plugin#38013
nsarupr merged 4 commits intoreleasefrom
chore/appsmith-ai-refactor

Conversation

@nsarupr
Copy link
Contributor

@nsarupr nsarupr commented Dec 6, 2024

Description

Basic refactor to accommodate changes in Appsmith EE repository

Fixes #38020

Automation

/ok-to-test tags="@tag.Sanity"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12230086087
Commit: 9e684a1
Cypress dashboard.
Tags: @tag.Sanity
Spec:


Mon, 09 Dec 2024 06:52:45 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Improved execution handling for AI server service queries, enhancing error management and response clarity.
    • Introduced new methods for streamlined execution and error handling.
  • Bug Fixes

    • Enhanced error handling for file upload and listing operations, ensuring appropriate responses in case of errors or no files available.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Walkthrough

The changes in the AppsmithAiPlugin.java file focus on refactoring the AppsmithAiPluginExecutor class, particularly the executeCommon method. The refactoring includes the introduction of new private methods for execution handling and error management, enhancing modularity and clarity. The error handling process has been centralized, and redundant code has been removed. The updates aim to improve the control flow and maintainability of the code, particularly in handling execution results and errors related to AI server service operations.

Changes

File Path Change Summary
app/server/appsmith-plugins/appsmithAiPlugin/src/main/java/com/external/plugins/AppsmithAiPlugin.java Refactored executeCommon method; added handleExecution, handleExecuteForAiServerService, and handleError methods; improved error handling and control flow.

Possibly related PRs

Suggested labels

Backend

Suggested reviewers

  • nidhi-nair
  • sondermanish
  • trishaanand

🎉 In the realm of code, where logic does flow,
Refactoring brings clarity, as we all know.
With methods anew, and errors in tow,
The plugin now dances, with a graceful glow!
So here's to the changes, both bold and bright,
In the world of Appsmith, everything feels right! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Dec 6, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
app/server/appsmith-plugins/appsmithAiPlugin/src/main/java/com/external/plugins/AppsmithAiPlugin.java (1)

213-213: Include the throwable in log.error to capture stack trace.

Passing the exception to log.error will help in debugging by logging the full stack trace.

Apply this diff:

-log.error(
-    "An error has occurred while trying to run the AI server API query. Error: {}", error.getMessage());
+log.error(
+    "An error has occurred while trying to run the AI server API query.", error);
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fd9efb8 and 89eadb2.

📒 Files selected for processing (1)
  • app/server/appsmith-plugins/appsmithAiPlugin/src/main/java/com/external/plugins/AppsmithAiPlugin.java (1 hunks)
🔇 Additional comments (3)
app/server/appsmith-plugins/appsmithAiPlugin/src/main/java/com/external/plugins/AppsmithAiPlugin.java (3)

178-181: Refactoring enhances code modularity and readability.


183-192: New handleExecution method improves separation of concerns.


194-207: handleExecuteForAiServerService cleanly encapsulates AI server execution logic.

@github-actions github-actions bot added Anvil Pod Issue related to Anvil project Task A simple Todo labels Dec 6, 2024
@nsarupr nsarupr added the ok-to-test Required label for CI label Dec 6, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
app/server/appsmith-plugins/appsmithAiPlugin/src/main/java/com/external/plugins/AppsmithAiPlugin.java (2)

183-192: Consider simplifying the handleExecution method

The method can be simplified by removing the intermediate variable and directly returning the chain.

 private Mono<ActionExecutionResult> handleExecution(
         AiFeatureService aiFeatureService,
         AiServerRequestDTO aiServerRequestDTO,
         SourceDetails sourceDetails,
         ActionExecutionRequest actionExecutionRequest) {
-    Mono<ActionExecutionResult> actionExecutionResultMono;
-    actionExecutionResultMono =
-            handleExecuteForAiServerService(aiServerRequestDTO, sourceDetails, actionExecutionRequest);
-    return actionExecutionResultMono.onErrorResume(this::handleError);
+    return handleExecuteForAiServerService(aiServerRequestDTO, sourceDetails, actionExecutionRequest)
+            .onErrorResume(this::handleError);
 }

209-219: Enhance error logging for better debugging

Consider including the error type in the log message for better error tracking.

-    log.error(
-            "An error has occurred while trying to run the AI server API query. Error: {}", error.getMessage());
+    log.error(
+            "An error has occurred while trying to run the AI server API query. Error type: {}, Message: {}",
+            error.getClass().getSimpleName(),
+            error.getMessage());
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 89eadb2 and e15a0df.

📒 Files selected for processing (1)
  • app/server/appsmith-plugins/appsmithAiPlugin/src/main/java/com/external/plugins/AppsmithAiPlugin.java (1 hunks)
🔇 Additional comments (2)
app/server/appsmith-plugins/appsmithAiPlugin/src/main/java/com/external/plugins/AppsmithAiPlugin.java (2)

178-181: LGTM! Good separation of concerns

The refactoring improves code organization by delegating execution handling to a dedicated method.


194-207: LGTM! Clean reactive implementation

The method properly handles the execution flow and result creation.

@nsarupr nsarupr requested a review from trishaanand December 6, 2024 11:20
@nsarupr nsarupr self-assigned this Dec 6, 2024
@github-actions
Copy link

github-actions bot commented Dec 6, 2024

Failed server tests

  • com.appsmith.server.solutions.ce.ActionExecutionSolutionCETest#testVariableSubstitutionWithNewline

@nsarupr nsarupr added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Dec 6, 2024
@nsarupr nsarupr merged commit 8991abb into release Dec 9, 2024
@nsarupr nsarupr deleted the chore/appsmith-ai-refactor branch December 9, 2024 07:30
github-actions bot pushed a commit to Zeral-Zhang/appsmith that referenced this pull request Dec 12, 2024
## Description
> Basic refactor to accommodate changes in Appsmith EE repository


Fixes appsmithorg#38020

## Automation

/ok-to-test tags="@tag.Sanity"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/12230086087>
> Commit: 9e684a1
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12230086087&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Sanity`
> Spec:
> <hr>Mon, 09 Dec 2024 06:52:45 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## Summary by CodeRabbit

- **New Features**
- Improved execution handling for AI server service queries, enhancing
error management and response clarity.
	- Introduced new methods for streamlined execution and error handling.

- **Bug Fixes**
- Enhanced error handling for file upload and listing operations,
ensuring appropriate responses in case of errors or no files available.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Nilesh Sarupriya <20905988+nsarupr@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Anvil Pod Issue related to Anvil project ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog Task A simple Todo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Appsmith AI to parse error and responses

2 participants